home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / g_man / cat3 / standard / readpixels.z / readpixels
Encoding:
Text File  |  2002-10-03  |  4.2 KB  |  133 lines

  1.  
  2.  
  3.  
  4. rrrreeeeaaaaddddppppiiiixxxxeeeellllssss((((3333GGGG))))                                                  rrrreeeeaaaaddddppppiiiixxxxeeeellllssss((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      rrrreeeeaaaaddddppppiiiixxxxeeeellllssss - returns values of specific pixels
  10.  
  11. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  12.      lllloooonnnngggg rrrreeeeaaaaddddppppiiiixxxxeeeellllssss((((nnnn,,,, ccccoooolllloooorrrrssss))))
  13.      sssshhhhoooorrrrtttt nnnn;;;;
  14.      CCCCoooolllloooorrrriiiinnnnddddeeeexxxx ccccoooolllloooorrrrssss[[[[]]]];;;;
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  17.      _n        expects the number of pixels to be read by the function.
  18.  
  19.      _c_o_l_o_r_s   expects the array in which the pixel values are to be stored.
  20.  
  21. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  22.      The returned value of this function is the number of pixels actually
  23.      read.  A returned function value of 0 indicates an error, that the
  24.      starting point is not a valid character position.
  25.  
  26. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.      rrrreeeeaaaaddddppppiiiixxxxeeeellllssss attempts to read up to _n pixel values from the bitplanes in
  28.      color map mode.  It reads them into the array _c_o_l_o_r_s starting from the
  29.      current character position along a single scan line (constant _y) in the
  30.      direction of increasing _x.  rrrreeeeaaaaddddppppiiiixxxxeeeellllssss returns the number of pixels read,
  31.      which is the number requested if the starting point is a valid character
  32.      position (inside the current viewport).  rrrreeeeaaaaddddppppiiiixxxxeeeellllssss returns zero if the
  33.      starting point is not a valid character position. The values of pixels
  34.      read outside the viewport or the screen are undefined.  rrrreeeeaaaaddddppppiiiixxxxeeeellllssss
  35.      updates the current character position to one pixel to the right of the
  36.      last one read; the current character position is undefined if the new
  37.      position is outside the viewport.
  38.  
  39.      In double buffer mode, only the back buffer is read by default. On
  40.      machines that support it, you can use rrrreeeeaaaaddddssssoooouuuurrrrcccceeee to control which buffer
  41.      is read.
  42.  
  43.      The system must be in color map mode for rrrreeeeaaaaddddppppiiiixxxxeeeellllssss to function
  44.      correctly.
  45.  
  46. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  47.      lrectread, readsource
  48.  
  49. NNNNOOOOTTTTEEEESSSS
  50.      rrrreeeeaaaaddddppppiiiixxxxeeeellllssss should not be used in new development.  Rather, pixels should
  51.      be read using the high-performance llllrrrreeeeccccttttrrrreeeeaaaadddd command.
  52.  
  53.      This routine is available only in immediate mode.
  54.  
  55.      The upper bits of a color value (an element of the _c_o_l_o_r_s array) are
  56.      undefined.  You can write this information to the frame buffer without
  57.      problems.  However, if you intend to interpret this data, be sure you
  58.      mask out the upper bits.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. rrrreeeeaaaaddddppppiiiixxxxeeeellllssss((((3333GGGG))))                                                  rrrreeeeaaaaddddppppiiiixxxxeeeellllssss((((3333GGGG))))
  71.  
  72.  
  73.  
  74. BBBBUUUUGGGGSSSS
  75.      On IRIS-4D GT and GTX models, when reading pixels from the PUPMODE
  76.      planes, the returned bits are shifted up by two bits.
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.